From a381648faac7e9930d6fbb0535e955beb1458cf5 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 28 Nov 2001 23:41:12 +0000 Subject: [PATCH] Typo fixes. (#65607) * gtk/gtkaccelmap.c: Typo fixes. (#65607) * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): Fix docs. (#65505) * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. * gtk/tmpl/gtkwindow.sgml: Document gtk_window_position. * gdk/tmpl/dnd.sgml: Document GdkDragProtocol and GdkDragContext. * gdk/tmpl/events.sgml: Document gdk_setting_get. * gdk/tmpl/fonts.sgml: Document gdk_font_full_name_get and gdk_font_full_name_free. * gdk/tmpl/windows.sgml: Document gdk_window_register_dnd. --- ChangeLog | 9 ++ ChangeLog.pre-2-0 | 9 ++ ChangeLog.pre-2-10 | 9 ++ ChangeLog.pre-2-2 | 9 ++ ChangeLog.pre-2-4 | 9 ++ ChangeLog.pre-2-6 | 9 ++ ChangeLog.pre-2-8 | 9 ++ docs/reference/ChangeLog | 15 ++- docs/reference/gdk/tmpl/dnd.sgml | 47 +++++----- docs/reference/gdk/tmpl/events.sgml | 26 ++--- docs/reference/gdk/tmpl/fonts.sgml | 125 +++++++++---------------- docs/reference/gdk/tmpl/windows.sgml | 4 +- docs/reference/gtk/tmpl/gtkwindow.sgml | 2 +- gtk/gtkaccelmap.c | 8 +- gtk/gtkfixed.c | 4 +- gtk/gtkwindow.c | 8 ++ 16 files changed, 177 insertions(+), 125 deletions(-) diff --git a/ChangeLog b/ChangeLog index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 8019e8e1fb..12fabcc80c 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,12 @@ +2001-11-28 Matthias Clasen + + * gtk/gtkaccelmap.c: Typo fixes. (#65607) + + * gtk/gtkfixed.c (gtk_fixed_set_has_window, gtk_fixed_get_has_window): + Fix docs. (#65505) + + * gtk/gtkwindow.c (gtk_window_set_mnemnonic_modifier): Document. + Wed Nov 28 18:19:12 2001 Owen Taylor * gtk/gtkmenu.c (gtk_menu_set_tearoff_hints): Move diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index ac88584831..58d61370fa 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,6 +1,19 @@ 2001-11-28 Matthias Clasen - gdk/tmpl/windows.sgml, gdk/tmpl/general.sgml, + * gtk/tmpl/gtkwindow.sgml: Document gtk_window_position. + + * gdk/tmpl/dnd.sgml: Document GdkDragProtocol and GdkDragContext. + + * gdk/tmpl/events.sgml: Document gdk_setting_get. + + * gdk/tmpl/fonts.sgml: Document gdk_font_full_name_get and + gdk_font_full_name_free. + + * gdk/tmpl/windows.sgml: Document gdk_window_register_dnd. + +2001-11-28 Matthias Clasen + + * gdk/tmpl/windows.sgml, gdk/tmpl/general.sgml, gdk/tmpl/pixmaps.sgml, gdk/tmpl/drawing.sgml, gdk/tmpl/gcs.sgml: Updates. diff --git a/docs/reference/gdk/tmpl/dnd.sgml b/docs/reference/gdk/tmpl/dnd.sgml index d48f0f187a..066114ccd8 100644 --- a/docs/reference/gdk/tmpl/dnd.sgml +++ b/docs/reference/gdk/tmpl/dnd.sgml @@ -7,7 +7,8 @@ functions for controlling drag and drop handling. These functions provide a low level interface for drag and drop. -GDK supports both the Xdnd and Motif drag and drop protocols transparently. +The X backend of GDK supports both the Xdnd and Motif drag and drop protocols +transparently, the Win32 backend supports the WM_DROPFILES protocol. GTK+ provides a higher level abstraction based on top of these functions, @@ -95,8 +96,6 @@ the GTK+ documentation for more information. @window: @targets: @Returns: - -@actions: @@ -113,8 +112,6 @@ the GTK+ documentation for more information. @possible_actions: @time: @Returns: - -@action: @@ -139,16 +136,18 @@ the GTK+ documentation for more information. - +Is used in #GdkDragContext to indicate the protocol according to +which DND is done. -@GDK_DRAG_PROTO_MOTIF: -@GDK_DRAG_PROTO_XDND: -@GDK_DRAG_PROTO_ROOTWIN: -@GDK_DRAG_PROTO_NONE: -@GDK_DRAG_PROTO_WIN32_DROPFILES: -@GDK_DRAG_PROTO_OLE2: -@GDK_DRAG_PROTO_LOCAL: +@GDK_DRAG_PROTO_MOTIF: The Motif DND protocol. +@GDK_DRAG_PROTO_XDND: The Xdnd protocol. +@GDK_DRAG_PROTO_ROOTWIN: An extension to the Xdnd protocol for + unclaimed root window drops. +@GDK_DRAG_PROTO_NONE: no protocol. +@GDK_DRAG_PROTO_WIN32_DROPFILES: The simple WM_DROPFILES protocol. +@GDK_DRAG_PROTO_OLE2: The complex OLE2 DND protocol (not implemented). +@GDK_DRAG_PROTO_LOCAL: Intra-application DND. @@ -160,19 +159,21 @@ the GTK+ documentation for more information. - +A GdkDragContext holds information about a +drag in progress. It is used on both source and destination sides. -@parent_instance: -@protocol: -@is_source: -@source_window: -@dest_window: -@targets: -@actions: -@suggested_action: +@parent_instance: +@protocol: the DND protocol which governs this drag. +@is_source: %TRUE if the context is used on the source side. +@source_window: the source of this drag. +@dest_window: the destination window of this drag. +@targets: a list of targets accepted on the destination. +@actions: a bitmask of all possible actions. +@suggested_action: the suggested action. @action: -@start_time: +@start_time: a timestamp recording the start time of this drag. + diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index f7955489a7..b64fa22af8 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -152,7 +152,7 @@ is given in the GLib Main Loop. Checks if any events are waiting to be processed. -@Returns: TRUE if any events are pending. +@Returns: %TRUE if any events are pending. @@ -162,7 +162,7 @@ Gets a copy of the first #GdkEvent in the event queue. It only checks the events that have already been moved to the GDK event queue.) -@Returns: a copy of the first #GdkEvent on the event queue, or NULL if no +@Returns: a copy of the first #GdkEvent on the event queue, or %NULL if no events are in the queue. The returned #GdkEvent should be freed with gdk_event_free(). @@ -173,7 +173,7 @@ Gets the next #GdkEvent to be processed, fetching events from the X server if necessary. -@Returns: the next #GdkEvent to be processed, or NULL if no events are pending. +@Returns: the next #GdkEvent to be processed, or %NULL if no events are pending. The returned #GdkEvent should be freed with gdk_event_free(). @@ -185,7 +185,7 @@ GraphicsExpose events are handled before the widget is scrolled. @window: the #GdkWindow to wait for the events for. -@Returns: a #GdkEventExpose if a GraphicsExpose was received, or NULL if a +@Returns: a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a NoExpose event was received. @@ -225,7 +225,7 @@ Gets the timestamp from a #GdkEvent. @event: a #GdkEvent. -@Returns: the timestamp from @event, or #GDK_CURRENT_TIME if the event has +@Returns: the timestamp from @event, or %GDK_CURRENT_TIME if the event has no timestamp. @@ -350,19 +350,23 @@ Returns non-zero if event debugging output is enabled. Sets whether event debugging information is output. Note that GTK+ must be compiled with debugging enabled, i.e. using the -'--enable-debug' configure option. + configure option. -@show_events: TRUE to output event debugging information. +@show_events: %TRUE to output event debugging information. - +Obtains a desktop-wide setting, such as the double-click time. + + +FIXME needs a list of valid settings here, or a link to +more information. -@name: -@value: -@Returns: +@name: the name of the setting. +@value: location to store the value of the setting. +@Returns: %TRUE if the value has been successfully stored. diff --git a/docs/reference/gdk/tmpl/fonts.sgml b/docs/reference/gdk/tmpl/fonts.sgml index 858f052fa9..cfacfd0e49 100644 --- a/docs/reference/gdk/tmpl/fonts.sgml +++ b/docs/reference/gdk/tmpl/fonts.sgml @@ -6,7 +6,7 @@ loading and manipulating fonts -The GdkFont data type represents a font for drawing on +The #GdkFont data type represents a font for drawing on the screen. These functions provide support for loading fonts, and also for determining the dimensions of characters and strings when drawn with a particular @@ -147,7 +147,7 @@ the registry and and encoding fields match the desired character set, then that font is used, otherwise if the XLFD contains wild-cards for the registry and encoding fields, the registry and encoding for the desired character -set are subsituted in and a lookup is done. If a match is found +set are substituted in and a lookup is done. If a match is found that font is used. Otherwise, processing continues on to the next font in the list. @@ -197,7 +197,7 @@ of forms of string input: Wide character string - For a number of the text-measuring functions, GTK+ + For a number of the text-measuring functions, GDK provides a variant (such as gdk_text_width_wc()) which takes a GdkWChar * instead of a gchar *. The input is then taken to @@ -265,64 +265,29 @@ here). -The GdkFont structure represents a font or fontset. It -contains the following public fields. A new GdkFont +The GdkFont structure represents a font or fontset. It +contains the following public fields. A new GdkFont structure is returned by gdk_font_load() or gdk_fontset_load(), and is reference counted with gdk_font_ref() and gdk_font_unref() - - - - - - -type -a value of type #GdkFontType which indicates -whether this font is a single font or a fontset. - - - -ascent -the maximum distance that the font, when drawn, -ascends above the baseline. - - - -descent -the maximum distance that the font, when drawn, -descends below the baseline. - - - -@type: -@ascent: -@descent: +@type: a value of type #GdkFontType which indicates + whether this font is a single font or a fontset. +@ascent: the maximum distance that the font, when drawn, + ascends above the baseline. +@descent: the maximum distance that the font, when drawn, +descends below the baseline. + Indicates the type of a font. The possible values are currently: - - - - - - -GDK_FONT_FONT -the font is a single font. - - - -GDK_FONT_FONT -the font is a fontset. - - - -@GDK_FONT_FONT: -@GDK_FONT_FONTSET: +@GDK_FONT_FONT: the font is a single font. +@GDK_FONT_FONTSET: the font is a fontset. + @@ -330,14 +295,12 @@ Loads a font. -Currently, this function will always return a new -font, however, in the future, it may be changed to -look up the font in a cache. You should make no -assumptions about the initial reference count. +The font may be newly loaded or looked up the font in a cache. +You should make no assumptions about the initial reference count. @font_name: a XLFD describing the font to load. -@Returns: a #GdkFont, or NULL if the font could not be loaded. +@Returns: a #GdkFont, or %NULL if the font could not be loaded. @@ -345,15 +308,13 @@ assumptions about the initial reference count. Loads a fontset. -Currently this function will always return a new -font, however, in the future, it may be changed to -look up the font in a cache. You should make no -assumptions about the initial reference count. +The fontset may be newly loaded or looked up in a cache. +You should make no assumptions about the initial reference count. @fontset_name: a comma-separated list of XLFDs describing the component fonts of the fontset to load. -@Returns: a #GdkFont, or NULL if the fontset could not be loaded. +@Returns: a #GdkFont, or %NULL if the fontset could not be loaded. @@ -367,7 +328,7 @@ assumptions about the initial reference count. -Increase the reference count of a count by one. +Increases the reference count of a font by one. @font: a #GdkFont @@ -376,7 +337,7 @@ Increase the reference count of a count by one. -Decrease the reference count of a count by one. +Decreases the reference count of a font by one. If the result is zero, destroys the font. @@ -406,11 +367,11 @@ not currently work correctly for fontsets. -Returns the metrics of a NULL-terminated string. +Returns the metrics of a nul-terminated string. @font: a #GdkFont. -@string: the NULL-terminated string to measure. +@string: the nul-terminated string to measure. @lbearing: the left bearing of the string. @rbearing: the right bearing of the string. @width: the width of the string. @@ -452,20 +413,20 @@ Returns the metrics of a string of wide characters. -Determine the width of a NULL-terminated string. +Determines the width of a nul-terminated string. (The distance from the origin of the string to the point where the next string in a sequence of strings should be drawn) @font: a #GdkFont -@string: the NULL-terminated string to measure +@string: the nul-terminated string to measure @Returns: the width of the string in pixels. -Determine the width of a given string. +Determines the width of a given string. @font: a #GdkFont @@ -476,7 +437,7 @@ Determine the width of a given string. -Determine the width of a given wide-character string. +Determines the width of a given wide-character string. @font: a #GdkFont @@ -487,7 +448,7 @@ Determine the width of a given wide-character string. -Determine the width of a given character. +Determines the width of a given character. @font: a #GdkFont @@ -497,7 +458,7 @@ Determine the width of a given character. -Determine the width of a given wide character. (Encoded +Determines the width of a given wide character. (Encoded in the wide-character encoding of the current locale). @@ -509,14 +470,14 @@ in the wide-character encoding of the current locale). Determines the distance from the origin to the rightmost -portion of a NULL-terminated string when drawn. This is not the +portion of a nul-terminated string when drawn. This is not the correct value for determining the origin of the next portion when drawing text in multiple pieces. See gdk_string_width(). @font: a #GdkFont -@string: the NULL-terminated string to measure. +@string: the nul-terminated string to measure. @Returns: the right bearing of the string in pixels. @@ -550,14 +511,14 @@ portion when drawing text in multiple pieces. -Determines the total height of a given NULL-terminated +Determines the total height of a given nul-terminated string. This value is not generally useful, because you cannot determine how this total height will be drawn in relation to the baseline. See gdk_string_extents(). @font: a #GdkFont -@string: the NULL-terminated string to measure. +@string: the nul-terminated string to measure. @Returns: the height of the string in pixels. @@ -590,19 +551,21 @@ relation to the baseline. See gdk_text_extents(). - +Returns a comma-separated list of XLFDs for the +fonts making up a given #GdkFont. -@font: -@Returns: +@font: a #GdkFont +@Returns: a newly-allocated string containing a list of XLFDs, + should be freed with gdk_font_full_name_free() when no longer needed. - +Frees a full font name obtained from gdk_font_full_name_get(). -@name: +@name: a full font name. @@ -648,7 +611,7 @@ Multi-Byte String'). @src: a wide character string. -@Returns: the multi-byte string corresponding to @src, or NULL if the +@Returns: the multi-byte string corresponding to @src, or %NULL if the conversion failed. The returned string should be freed with g_free() when no longer needed. @@ -661,7 +624,7 @@ Character String'). @dest: the space to place the converted wide character string into. -@src: the multi-byte string to convert, which must be null-terminated. +@src: the multi-byte string to convert, which must be nul-terminated. @dest_max: the maximum number of wide characters to place in @dest. @Returns: the number of wide characters written into @dest, or -1 if the conversion failed. diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml index 16cc78106c..51337cabc6 100644 --- a/docs/reference/gdk/tmpl/windows.sgml +++ b/docs/reference/gdk/tmpl/windows.sgml @@ -528,10 +528,10 @@ Deprecated equivalent to gdk_draw_drawable(), see that function for docs - +Registers a window as a potential drop destination. -@window: +@window: a #GdkWindow. diff --git a/docs/reference/gtk/tmpl/gtkwindow.sgml b/docs/reference/gtk/tmpl/gtkwindow.sgml index b39b89f9b1..2b915f2385 100644 --- a/docs/reference/gtk/tmpl/gtkwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkwindow.sgml @@ -165,7 +165,7 @@ it's larger - +Deperecated alias for gtk_window_set_position(). diff --git a/gtk/gtkaccelmap.c b/gtk/gtkaccelmap.c index 00131a5bb5..3f7c8f5e17 100644 --- a/gtk/gtkaccelmap.c +++ b/gtk/gtkaccelmap.c @@ -115,10 +115,10 @@ _gtk_accel_path_is_valid (const gchar *accel_path) * To change the accelerator during runtime programatically, use * gtk_accel_map_change_entry(). * The accelerator path must consist of "<WINDOWTYPE>/Category1/Category2/.../Action", - * where WINDOWTYPE should be a unique application specifc identifier, that + * where WINDOWTYPE should be a unique application-specific identifier, that * corresponds to the kind of window the accelerator is being used in, e.g. "Gimp-Image", * "Abiword-Document" or "Gnumeric-Settings". - * The Category1/.../Action portion is most apropriately choosen by the action the + * The Category1/.../Action portion is most appropriately chosen by the action the * accelerator triggers, i.e. for accelerators on menu items, choose the item's menu path, * e.g. "File/Save As", "Image/View/Zoom" or "Edit/Select All". * So a full valid accelerator path may look like: @@ -378,10 +378,10 @@ internal_change_entry (const gchar *accel_path, * @returns: %TRUE if the accelerator could be changed, %FALSE otherwise * * Change the @accel_key and @accel_mods currently associated with @accel_path. - * Due to conflicts with other accelerators, a change may not alwys be possible, + * Due to conflicts with other accelerators, a change may not always be possible, * @replace indicates whether other accelerators may be deleted to resolve such * conflicts. A change will only occur if all conflicts could be resolved (which - * might not be the case if conflicting accelerators are locked). Succesful + * might not be the case if conflicting accelerators are locked). Successful * changes are indicated by a %TRUE return value. */ gboolean diff --git a/gtk/gtkfixed.c b/gtk/gtkfixed.c index 4781c0f898..ccd6db5bbb 100644 --- a/gtk/gtkfixed.c +++ b/gtk/gtkfixed.c @@ -514,7 +514,7 @@ gtk_fixed_forall (GtkContainer *container, * Sets whether a #GtkFixed widget is created with a separate * #GdkWindow for widget->window or not. (By default, it will be * created with no separate #GdkWindow). This function must be called - * while the is not realized, for instance, immediately after the + * while the #GtkFixed is not realized, for instance, immediately after the * window is created. **/ void @@ -540,7 +540,7 @@ gtk_fixed_set_has_window (GtkFixed *fixed, * Gets whether the #GtkFixed has it's own #GdkWindow. * See gdk_fixed_set_has_window(). * - * Return value: + * Return value: %TRUE if @fixed has its own window. **/ gboolean gtk_fixed_get_has_window (GtkFixed *fixed) diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index 7940073afd..915527eb67 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -1223,6 +1223,14 @@ gtk_window_mnemonic_activate (GtkWindow *window, return FALSE; } +/** + * gtk_window_set_mnemonic_modifier: + * @window: a #GtkWindow + * @modifier: the modifier mask used to activate + * mnemonics on this window. + * + * Sets the mnemonic modifier for this window. + **/ void gtk_window_set_mnemonic_modifier (GtkWindow *window, GdkModifierType modifier) -- 2.30.2